Preparing Documentation
- Documentation should be in markdown format
- You can refer here for markdown guide
- You can use online markdown editors to create your own markdown documents.
Sections of the Documentation
API Description
API Flows
Authorization (same as other APIs) ( refer http://docs.ideabiz.lk/APIs/PIN-Verification)
API Methods
- URL
- Method
- Request Sample
- Request parameter table
- Sample success response
- Response code and parameters table
- Other responses
Other notes and error codes
for example you can refer this API format